// Copyright (c) 2011, Marc-Andre Ferland - madrang@gmail.com
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the The Warrent Team nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
//     * This software is free for non-commercial use. You may not use this
//       software, in whole or in part, in support of any commercial product
//       without the express consent of the author.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE WARRENT TEAM BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
using System;

namespace OsHelper.UsbNet.Transfer
{
	public delegate void TransferDelegate (iTransfer Source);
	
	public interface iTransfer
	{
		event TransferDelegate Completed;
		
		/// <summary>
		/// Submits this transfer.
		/// </summary>
		/// <remarks>
		/// This functions submits the USB transfer and return immediately.
		/// </remarks>
		void Submit ();

		/// <summary>
		/// Cancels this transfer.
		/// </summary>
		void Cancel ();

		/// <summary>
		/// Gets the data buffer.
		/// </summary>
        byte[] Buffer { get; }

		/// <summary>
        /// Actual length of data that was transferred. 
        /// </summary>
        int ActualLength { get; }
		
        /// <summary>
        /// Length of the data buffer.
        /// </summary>
		int Length { get; }
		
		/// <summary>
		/// The status of the transfer.
		/// </summary>
		UsbNet.Transfer.Status Status { get; }
		
		/// <summary>
        /// Timeout for this transfer in millseconds.
        /// </summary>
        int Timeout { get; set; }
		
		/// <summary>
		/// Enpoint used for the transfer.
		/// </summary>
		UsbNet.Descriptors.EndpointDescriptor Endpoint { get; }
		
		/// <summary>
		/// Device to send data to.
		/// </summary>
		OsHelper.UsbNet.UsbDevice Device { get; }
		
		/// <summary>
		/// Number of isochronous packets. 
		/// </summary>
		int NumberIsoPackets { get; }
		
		/// <summary>
		/// Gets a <see cref="IsoPacket"/> that represents the specified iso packet descriptor. 
		/// </summary>
		/// <param name="PacketNumber">The iso packet descriptor to return.</param>
		/// <returns>The <see cref="IsoPacket"/> that represents <paramref name="PacketNumber"/>.</returns>
		IsoPacket GetIsoPacket (int PacketNumber);
		
		/// <summary>
		/// Convenience function to locate the position of an isochronous packet within
		/// the buffer of an isochronous transfer. 
		/// </summary>
		/// <remarks>
		/// <para>
		/// This is a thorough function which loops through all preceding packets,
		/// accumulating their lengths to find the position of the specified packet.
		/// Typically you will assign equal lengths to each packet in the transfer,
		/// and hence the above method is sub-optimal.
		/// You may wish to use <see cref="GetIsoPacketBufferSimple"/> instead.
		/// </para>
		/// </remarks>
		byte[] GetIsoPacketBuffer (int Packet);

		/// <summary>
		/// Convenience function to locate the position of an isochronous packet
		/// within the buffer of an isochronous transfer,
		/// for transfers where each packet is of identical size.
		/// </summary>
		byte[] GetIsoPacketBufferSimple (int Packet);

		/// <summary>
		/// Convenience function to set the length of all packets in an isochronous transfer, based on the NumberIsoPackets field in the transfer structure. 
		/// </summary>
		void SetIsoPacketLengths (int Length);
		
		void SetBuffer(byte[] Buffer);
		
		void SetEndpoint(OsHelper.UsbNet.UsbDevice Dev, OsHelper.UsbNet.Descriptors.EndpointDescriptor Endpoint);
		
	}
}
